Add CONTRIBUTING.md #470
Merged
Add CONTRIBUTING.md #470
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liamsi
reviewed
Jul 22, 2020
liamsi
reviewed
Jul 22, 2020
CONTRIBUTING.md
Outdated
| Issue. The issue helps capture the problem you're trying to solve and allows for | ||
| early feedback. Once the issue is created, maintainers may request more detailed | ||
| documentation be written in the form of a Request for Comment (RFC) or | ||
| Architectural Decision Record (ADR). |
There was a problem hiding this comment.
Maybe link to https://github.com/informalsystems/tendermint-rs/blob/master/docs/architecture/README.md (?)
Not sure if there is an RFC equivalent (I do not think so).
liamsi
reviewed
Jul 22, 2020
| When the problem is well understood but the solution leads to large | ||
| structural changes to the code base, these changes should be proposed in | ||
| the form of an [Architectural Decision Record | ||
| (ADR)](./docs/architecture/). The ADR will help build consensus on an |
There was a problem hiding this comment.
Ah OK 👌 Still valuable to link to the ADR readme above I think.
liamsi
reviewed
Jul 22, 2020
CONTRIBUTING.md
Outdated
| - [module] \#xxx Some description about the change (@contributor) | ||
| ``` | ||
| Here, `module` is the part of the code that changed (typically a | ||
| top-level package), `xxx` is the pull-request number, and `contributor` |
There was a problem hiding this comment.
Is package a relict from go-land? The top-level dirs here represent crates. One level below it's usually modules.
liamsi
reviewed
Jul 22, 2020
CONTRIBUTING.md
Outdated
| Note this means pull-requests should be opened first so the changelog can then | ||
| be updated with the pull-request's number. | ||
| There is no need to include the full link, as this will be added | ||
| automatically during release. But please include the backslash and pound, eg. `\#2313`. |
There was a problem hiding this comment.
as this will be added automatically during release
That is not the case (yet). In tendermint go there is a python script which does this. Not here.
Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>
liamsi
approved these changes
Jul 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provide an initial CONTRIBUTING.md
Missing several key sections but hoping this can get us started.
Closes #323